Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #288, Add Workflow README #292

Merged
merged 1 commit into from
Jul 13, 2021
Merged

Fix #288, Add Workflow README #292

merged 1 commit into from
Jul 13, 2021
+64 −44

Conversation

ArielSAdamsNASA
Copy link
Contributor

Checklist (Please check before submitting)

Describe the contribution
Fixes #288
Add a README in .github/workflows

Expected behavior changes
Users will know what each workflow does.

Contributor Info - All information REQUIRED for consideration of pull request
Ariel Adams, ASRC Federal

astrogeco
astrogeco suggested changes Jul 7, 2021
View reviewed changes
Copy link
Contributor

@astrogeco astrogeco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, can you fix the headings so that they are second level ## instead?

.github/workflows/README.md Outdated
Our CodeQL action uses a configuration file to use specific queries, which can be found at [.github/codeql](https://github.com/nasa/cFS/tree/main/.github/codeql).


##### Static Analaysis
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Embed link to cppcheck

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added

For more information about Cppcheck, visit http://cppcheck.sourceforge.net/.

.github/workflows/README.md Outdated
##### Deprecated Build, Test, and Run
[![Deprecated Build, Test, and Run](https://github.com/nasa/cfs/actions/workflows/build-cfs-deprecated.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/build-cfs-deprecated.yml)

This action builds, tests, and runs the cFS bundle using deprecated code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mention the OMIT_DEPRECATED flag and maybe link to the cmake documantation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is the cmake documentation?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linked to global_build_options.cmake

.github/workflows/README.md
##### Documentation and Guides
[![Documentation and Guides](https://github.com/nasa/cfs/actions/workflows/build-documentation.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/build-documentation.yml)

This action creates doxygen documents for cFE, cFS users guide, and osal guide.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe add that it also pushes the pdf for pushes to main

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added:

Documentation and Guides is ran for every push and every pull request on all branches of cFS in Github Actions. The workflow pushes the PDFs for every push on the main branch.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good, we might also want to add the link to where the documentation is pushed to:
https://github.com/nasa/cfs/tree/gh-pages

@ArielSAdamsNASA ArielSAdamsNASA force-pushed the fix-288-workflows-readme branch 2 times, most recently from b6d7f85 to 6a25507 Compare July 8, 2021 15:07
@astrogeco astrogeco added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Jul 8, 2021
astrogeco
astrogeco suggested changes Jul 8, 2021
View reviewed changes
Copy link
Contributor

@astrogeco astrogeco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor comments. We might want to change the order of these and have the build ones up first.

Also, replace the section that covers this in Contributing.md with a link to this new readme

.github/workflows/README.md Outdated
## Format Check
[![Format Check](https://github.com/nasa/osal/actions/workflows/format-check.yml/badge.svg)](https://github.com/nasa/osal/actions/workflows/format-check.yml)

This action uses clang-format-10 to check for format errors.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add link to .clang-format config file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link https://releases.llvm.org/10.0.0/tools/clang/docs/ClangFormat.html?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Used https://github.com/nasa/cFS/blob/main/.clang-format

.github/workflows/README.md Outdated
## CodeQL Analysis
[![CodeQL Analaysis](https://github.com/nasa/cfs/actions/workflows/codeql-build.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/codeql-build.yml)

This action runs GitHub's industry-leading static analysis engine, CodeQL, against our repository's source code to find security vulnerabilities. It then automatically uploads the results to GitHub so they can be displayed in the repository's code scanning alerts found under the security tab. CodeQL runs an extensible set of [queries](https://github.com/github/codeql), which have been developed by the community and the [GitHub Security Lab](https://securitylab.github.com/) to find common vulnerabilities in your code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the "industry leading" part we can't be seen as "endorsing" a product

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed

.github/workflows/README.md Outdated Show resolved Hide resolved
.github/workflows/README.md
##### Documentation and Guides
[![Documentation and Guides](https://github.com/nasa/cfs/actions/workflows/build-documentation.yml/badge.svg)](https://github.com/nasa/cfs/actions/workflows/build-documentation.yml)

This action creates doxygen documents for cFE, cFS users guide, and osal guide.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good, we might also want to add the link to where the documentation is pushed to:
https://github.com/nasa/cfs/tree/gh-pages

@ArielSAdamsNASA ArielSAdamsNASA force-pushed the fix-288-workflows-readme branch 3 times, most recently from ccc9e07 to f097f06 Compare July 8, 2021 23:46
@astrogeco astrogeco changed the base branch from main to integration-candidate July 13, 2021 00:45
@astrogeco astrogeco merged commit b38bf85 into nasa:integration-candidate Jul 13, 2021
@ArielSAdamsNASA ArielSAdamsNASA deleted the fix-288-workflows-readme branch July 13, 2021 16:10
@astrogeco astrogeco added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@astrogeco astrogeco astrogeco requested changes

Assignees
No one assigned
Labels
CCB:Approved Indicates code review and approval by community CCB docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide README in .github/workflows
3 participants
@ArielSAdamsNASA @astrogeco @ArielSAdams